
<!DOCTYPE html>
<html>
  <head>
    <title>prototype</title>
    <link rel="stylesheet" href="prism.css">
    <link rel="stylesheet" href="style.css">
  </head>
  <body>
    <div id="header">
      <div class="doc-title"><a href="folktale.html"><span class="doc-title"><span class="product-name">Folktale</span><span class="version">v2.0.1</span></span></a><ul class="navigation"><li class="navigation-item"><a href="https://github.com/origamitower/folktale" title="">GitHub</a></li><li class="navigation-item"><a href="folktale.html#cat-2-support" title="">Support</a></li><li class="navigation-item"><a href="folktale.html#cat-3-contributing" title="">Contributing</a></li></ul></div>
    </div>
    <div id="content-wrapper"><div id="content-panel"><h1 class="entity-title">prototype</h1><div class="highlight-summary"><div><p>A container of methods for the variant.</p>
</div></div><div class="deprecation-section"><strong class="deprecation-title">This feature is experimental!</strong><p>This API is still experimental, so it may change or be removed in future versions. You should not rely on it for production applications.</p></div><h2 class="section-title">Documentation</h2><div class="documentation"><div><p>A container of methods for the variant.</p>
</div></div><div class="members"><h2 class="section-title" id="properties">Properties</h2><div class="member-category"><h3 class="category" id="cat-fantasy-land">Fantasy Land</h3><div class="member-list"><div class="member"><a class="member-name" href="-unknown-module-.folktale.concurrency.future._executionstate.variants.0.prototype.fantasy-land-equals.html">fantasy-land/equals(that)</a><div class="doc-summary"><div><p>Part of the Setoid instance for Fantasy Land 2.x+. See the <code>equals</code> method for details.</p>
</div></div><div class="special-tags"></div></div></div></div><div class="member-category"><h3 class="category" id="cat-meta-programming">Meta-programming</h3><div class="member-list"><div class="member"><a class="member-name" href="folktale.adt.union.union.derive.html">derive(...derivations)</a><div class="doc-summary"><div><p>Allows a function to provide functionality to variants in an union.</p>
</div></div><div class="special-tags"><span class="tagged experimental">Experimental</span><span class="tagged inherited">Inherited</span></div></div></div></div><div class="member-category"><h3 class="category" id="cat-special-values">Special Values</h3><div class="member-list"><div class="member"><a class="member-name" href="folktale.adt.union.union.constructor-3.html">get constructor</a><div class="doc-summary"><div><p>The constructor for the variant</p>
</div></div><div class="special-tags"></div></div><div class="member"><a class="member-name" href="-unknown-module-.folktale.concurrency.future._executionstate.variants.html">variants</a><div class="doc-summary"><div><p>The variants in the ExecutionState</p>
</div></div><div class="special-tags"><span class="tagged experimental">Experimental</span><span class="tagged inherited">Inherited</span></div></div></div></div><div class="member-category"><h3 class="category" id="cat-testing-and-comparing">Testing and Comparing</h3><div class="member-list"><div class="member"><a class="member-name" href="-unknown-module-.folktale.concurrency.future._executionstate.variants.0.prototype.hasinstance.html">hasInstance(value)</a><div class="doc-summary"><div><p>True if the value is any execution state instance.</p>
</div></div><div class="special-tags"><span class="tagged experimental">Experimental</span><span class="tagged inherited">Inherited</span></div></div></div></div><div class="member-category"><h3 class="category" id="cat-variant">Variant</h3><div class="member-list"><div class="member"><a class="member-name" href="folktale.concurrency.future._execution-state.cancelled.html">Cancelled()</a><div class="doc-summary"><div><p>The state of a future that has been cancelled.</p>
</div></div><div class="special-tags"><span class="tagged experimental">Experimental</span><span class="tagged inherited">Inherited</span></div></div><div class="member"><a class="member-name" href="folktale.concurrency.future._execution-state.0.html">Pending()</a><div class="doc-summary"><div><p>The state of a future that&#39;s still not resolved.</p>
</div></div><div class="special-tags"><span class="tagged experimental">Experimental</span><span class="tagged inherited">Inherited</span></div></div><div class="member"><a class="member-name" href="folktale.concurrency.future._execution-state.rejected.html">Rejected(reason)</a><div class="doc-summary"><div><p>The state of a future that has been resolved with a failure.</p>
</div></div><div class="special-tags"><span class="tagged experimental">Experimental</span><span class="tagged inherited">Inherited</span></div></div><div class="member"><a class="member-name" href="folktale.concurrency.future._execution-state.resolved.html">Resolved(value)</a><div class="doc-summary"><div><p>The state of a future that has been successfully resolved with a value.</p>
</div></div><div class="special-tags"><span class="tagged experimental">Experimental</span><span class="tagged inherited">Inherited</span></div></div></div></div><div class="member-category"><h3 class="category" id="cat--uncategorised-">(Uncategorised)</h3><div class="member-list"><div class="member"><a class="member-name" href="-unknown-module-.folktale.concurrency.future._executionstate.variants.0.prototype.cancelled.prototype.rejected.prototype.resolved.prototype.equals.html">equals(value)</a><div class="doc-summary"></div><div class="special-tags"><span class="tagged experimental">Experimental</span></div></div><div class="member"><a class="member-name" href="-unknown-module-.folktale.concurrency.future._executionstate.variants.0.prototype.cancelled.prototype.rejected.prototype.resolved.prototype.inspect.html">inspect: toString()</a><div class="doc-summary"></div><div class="special-tags"><span class="tagged experimental">Experimental</span></div></div><div class="member deprecated"><a class="member-name" href="-unknown-module-.folktale.concurrency.future._executionstate.variants.0.prototype.cancelled.prototype.rejected.prototype.resolved.prototype.isresolved.html">get isResolved</a><div class="doc-summary"></div><div class="special-tags"><span class="tagged deprecated">Deprecated</span></div></div><div class="member"><a class="member-name" href="-unknown-module-.folktale.concurrency.future._executionstate.variants.0.prototype.cancelled.prototype.rejected.prototype.resolved.prototype.matchwith.html">matchWith(pattern)</a><div class="doc-summary"></div><div class="special-tags"><span class="tagged experimental">Experimental</span></div></div><div class="member"><a class="member-name" href="-unknown-module-.folktale.concurrency.future._executionstate.variants.0.prototype.cancelled.prototype.rejected.prototype.resolved.prototype.inspect.html">toString()</a><div class="doc-summary"></div><div class="special-tags"><span class="tagged experimental">Experimental</span></div></div></div></div></div><div class="source-code"><h2 class="section-title" id="source-code">Source Code</h2><div class="source-location">Defined in source/adt/union/union.js at line 95, column 25</div><pre class="source-code"><code class="language-javascript">InternalConstructor.prototype</code></pre></div></div><div id="meta-panel"><div class="meta-section"><div class="meta-field"><strong class="meta-field-title">Stability</strong><div class="meta-field-value">experimental</div></div><div class="meta-field"><strong class="meta-field-title">Licence</strong><div class="meta-field-value">MIT</div></div><div class="meta-field"><strong class="meta-field-title">Module</strong><div class="meta-field-value">folktale/adt/union/union</div></div></div><div class="table-of-contents"><div class="meta-section-title">On This Page</div><ul class="toc-list level-1"><li class="toc-item"><span class="no-anchor">Documentation</span><ul class="toc-list level-2"></ul></li><li class="toc-item"><a href="#properties">Properties</a><ul class="toc-list level-2"><li class="toc-item"><a href="#cat-fantasy-land">Fantasy Land</a></li><li class="toc-item"><a href="#cat-meta-programming">Meta-programming</a></li><li class="toc-item"><a href="#cat-special-values">Special Values</a></li><li class="toc-item"><a href="#cat-testing-and-comparing">Testing and Comparing</a></li><li class="toc-item"><a href="#cat-variant">Variant</a></li><li class="toc-item"><a href="#cat--uncategorised-">(Uncategorised)</a></li></ul></li><li class="toc-item"><a href="#source-code">Source Code</a></li></ul></div><div class="meta-section"><strong class="meta-section-title">Authors</strong><div class="meta-field"><strong class="meta-field-title">Copyright</strong><div class="meta-field-value">(c) 2013-2017 Quildreen Motta, and CONTRIBUTORS</div></div><div class="meta-field"><strong class="meta-field-title">Authors</strong><div class="meta-field-value"><ul class="meta-list"><li>Quildreen Motta</li></ul></div></div><div class="meta-field"><strong class="meta-field-title">Maintainers</strong><div class="meta-field-value"><ul class="meta-list"><li>Quildreen Motta &lt;queen@robotlolita.me&gt; (http://robotlolita.me/)</li></ul></div></div></div></div></div>
    <script>
void function() {
  var xs = document.querySelectorAll('.documentation pre code');
  for (var i = 0; i < xs.length; ++i) {
    xs[i].className = 'language-javascript code-block';
  }
}()
    </script>
    <script src="prism.js"></script>
  </body>
</html>